Commodity form

Configuration Cargo Commodities Commodities view Commodity form

The Commodity form enables you to add and edit a commodity code. A commodity code is a site-specific code indicating the contents of a container. N4 applies rudimentary hazardous information to a container based on its commodity. You can also define the temperature requirements for refrigerated commodities. When you receive a container load of one of these commodities, N4 automatically applies the temperature requirements to the container at the gate.

You can use this form to manually add commodity codes or use the Actions Copy Reference Set option to copy commodity codes defined in an existing entity set.

To add or edit a commodity code:

  1. In the Commodity ID field, enter an ID that uniquely identifies the commodity.

You can use this code in data entry forms, such as the Booking Items form or the gate forms, to refer to the commodity.

  1. In the Commodity Short Name field, enter a short name for the commodity.

XPS uses a combination of Commodity ID and Commodity Short Name to identify a commodity. If the two values are same, it displays only the Commodity ID.

  1. In the Commodity Code field, enter the commodity code.

XPS displays the first character of the commodity code in the Information dialog.

  1. In the Icon #1 field, enter the (background/foreground) reference number for the icon that you want to use to identify the commodity in XPS.

  2. In the Icon #2 field, enter the (background/foreground) reference number for an alternate icon that you want to use to identify the commodity in XPS.

For more information, see Commodity icon reference. (on page 1)

XPS uses the alternate icon if the first icon is not available.

The Icon #1 and Icon #2 fields default to zero if you do not specify a value.

  1. Optionally, use the various check boxes, such as Is Food, Is Film, and Is Oils, to define additional characteristics of the commodity.

Currently, N4 does not use these check boxes to validate information about the commodity in any other data entry forms.

  1. In the Vertical Center of Gravity Ratio field, enter the vertical center of gravity ratio for the commodity.

To calculate the vertical center of gravity ratio divide the center of gravity of the container by the container height. The vertical center of gravity ratio must be greater than 0.0 and less than 1.0. The aggregate vertical center of gravity ratio affects the stability of the vessel.

  1. Enter other optional information for the commodity.

  2. Click Save.

The following table lists the optional fields in the Commodity form.

Field Label

Description

Description

Enter a short description for the commodity.

Icon

Select a media asset that represents the icon for the commodity in N4.

The lookup field displays the media assets that exist at the current scope level. To add a new icon as a media asset, see Media Assets view.

Is Archetype?

Select the check box to indicate that the selected commodity is the master commodity, that is, one of the standard commodities that you create in order to reference non-archetype commodities when you create/edit them. When you select this, N4 disables the Archetype drop-down list. You can also select this check box to convert a non-archetype commodity into an archetype commodity.

For example, you could have multiple commodity entries that are very similar, such as "frobeef", "froz beef", "fbeef". However, all these commodities could be grouped under a master commodity called FrozenBeef. So if another commodity is created that is similar to FrozenBeef, then you can apply the FrozenBeef commodity.

When you attempt to deselect this check box for the archetype commodity that is referenced by one or more non-archetype commodity(s), N4 raises an error message and does not allow you to deselect it.

If you add an Arch Commodity after XPS start-up, N4 sends this update to XPS only after you apply one of the subordinate commodities to a container, which in turn refers to the newly created Arch Commodity.

Archetype

Select an archetype commodity for the non-archetype commodity.

The drop-down list lists the archetype commodities that you created in the current scope level.

Non-reefer only

Select the check box if the commodity cannot be in a live reefer container.

If you select the Non-reefer only check box for a commodity, N4 clears and disables the Validate Temperature Range check box and the Validate Ideal Temperature check box for the commodity.

Minimum Temperature

Enter the minimum temperature required for the commodity.

Maximum Temperature

Enter the maximum temperature required for the commodity.

Validate Temperature Range

Select the check box if you want N4 to validate the temperature range specified for a commodity.

If you select the Validate Temperature Range check box, the Minimum Temperature field and the Maximum Temperature field are required fields for the commodity.

To reject a gate transaction if the temperature for a commodity is not specified or is not within the range, enter data in at least one of the temperature related fields, and configure the RejectCommodityTempRequired and RejectCommodityTempOutOfRange business tasks.

Ideal Temperature

Enter the ideal temperature for the commodity.

Validate Ideal Temperature

Select the check box if you want to validate the ideal temperature for a commodity.

If you select the Validate Ideal Temperature check box, the Ideal Temperature field is a required field for the commodity.

UN/NA Identification Number

Enter the UN/NA Identification Number for the commodity.

Validate Hazard

Select the check box if you want to validate the hazard information for the commodity at the gate.

You must include the RejectCommodityHazRequired business task in the gate configuration to reject a gate transaction and display appropriate error message for the user at the gate.

Vent Setting, %

Enter the ventilation requirements for the commodity.

To validate the ventilation requirements for a commodity at the gate, include the RejectCommodityVentRequired and RejectCommodityVentIncorrect business tasks in the gate configuration.

Humidity required, %

Enter the humidity requirements for the commodity.

N4 performs the following validations in any form that contains both the Commodity field and the Temp. Required field:

If you do not select any of the check boxes in the Commodity form, N4 does not perform any validations.

The various forms in N4 using the above validations are: